cs-security-experience-api-services icon

cs-security-experience-api-services

2.4.x
(0 reviews)

📘 API Documentation - Experience Security API Service

This section describes the attributes and usage of the Experience Security API Service.

💂️ Base Information

  • API Title: Experience Security API Service
  • Version: v2
  • Base URL: https://security-experience-api-{env}.us-e1.cloudhub.io/api/Replace {env} with:
    • dev (Development)
    • qa (Quality Assurance)
    • prod (Production)

🔑 Authentication

Required Headers

HeaderTypeDescription
AuthorizationStringBearer token in the format Bearer {{API_KEY}}
client_idStringUnique identifier for API clients
  • Authorization
    • Length: 36 - 37 characters
    • Example: Bearer abcdefghijklmnopqrstuvwxyz1234567890
  • client_id
    • Length: 32 - 36 characters
    • Example: 123e4567-e89b-12d3-a456-426614174000

📌 These headers are required in all requests.

✨ Endpoint: Validate Identity

POST /customer/v1/identity/validate

  • Description: Validates a person's identification data.

Request Body

{
  "idUsuarioEntidad": "string (Base64, optional)",
  "paramProducto": "string (required)",
  "producto": "string (required, e.g., '010')",
  "canal": "string (required, e.g., 'Fijo 001')",
  "datosValidacion": {
    "identificacion": {
      "Numero": "string (required)",
      "Tipo": "string (required, e.g., '1' or '4')"
    },
    "primerApellido": "string (max 16, required)",
    "nombres": "string (max 40, required)",
    "fechaExpedicion/timestamp": "string (timestamp, required)"
  }
}

Response Body

Returns an object RespValidacion with detailed validation results.

🔒 Endpoint: Initialize OTP

POST /security/v1/OTP/initialize

  • Description: Initiates an OTP transaction for identity verification.

Request Body

{
  "idUsuarioEntidad": "string (optional)",
  "iniciarTransaccionOTPSolicitud": {
    "codParametrizacion": "string (required)",
    "Identificacion": {
      "numero": "string (required)",
      "tipo": "string (required)"
    },
    "datosCuestionario": {
      "regValidacion": "string (required)",
      "procesoEvidente": "string (required)"
    }
  }
}

Response Body

Returns an object IniciarTransaccionOTPRespuesta with transaction details.

🔐 Endpoint: Validate OTP Code

POST /security/v1/OTP/validate

  • Description: Validates the OTP code for an active transaction.

Request Body

{
  "idUsuarioEntidad": "string (optional)",
  "verificarCodigoOTPSolicitud": {
    "idTransaccionOTP": "UUID (required)",
    "codigoOTP": "string (6 digits or '000000') (required)"
  }
}

Response Body

{
  "resultadoVerificacionOTP": true,
  "mensaje": "string (optional)"
}

📝 Other Endpoints

EndpointDescription
POST /security/v1/survey/generateGenerates a security questionnaire.
POST /security/v1/survey/validateValidates the completed survey.
POST /security/v1/portal/generate_tokenGenerates a portal token for PQRs.
POST /security/v1/portal/validate_tokenValidates a portal token for PQRs.
POST /security/v1/check_blsChecks applicant against blocking lists.

📎 Refer to associated example files for detailed schema:
- v1/examples/request/
- v1/examples/response/

📊 Common Parameters

ParameterTypeDescriptionRequired
client_idStringAPI client identifier✅
AuthorizationStringBearer token for authentication✅

🔐 Security Schemes

Client ID Enforcement

FieldTypeRequiredLengthRegex
client_idStringYes32 - 36[a-zA-Z0-9]
client_secretStringYes32 - 64[a-zA-Z0-9]

OAuth 2.0

FieldTypeRequiredLengthRegex
AuthorizationStringYes36 - 37[a-zA-Z0-9-_.]

⚠️ Error Codes

CodeDescriptionSuggested Solution
400Bad RequestCheck request syntax and parameters.
401UnauthorizedValidate authentication credentials.
404Not FoundConfirm the endpoint URL.
500Internal Server ErrorRetry or contact technical support.

📞 Support

For assistance, contact the Integration Services and Applications Coordination team.

Email: epalma@fg

Last updated: April 2025

Reviews